FOPPublisher.java

/*
 Copyright 2006 - 2010 Under Dusken

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
package org.pegadi.publisher;

import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.xmlgraphics.util.MimeConstants;
import org.pegadi.model.Article;
import org.pegadi.model.PublishingMediaEnum;
import org.pegadi.model.Stylesheet;
import org.w3c.dom.Document;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.*;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamSource;
import java.io.FileOutputStream;
import java.io.IOException;
import java.text.DateFormat;
import java.util.Map;
import java.util.Properties;

/**
 * @author Marvin B. Lillehaug <lillehau@underdusken.no>
 */
public abstract class FOPPublisher extends AbstractPublisher {
    private Properties transformerProperties;
    private FopFactory fopFactory = FopFactory.newInstance();

    public Document generateFO(Article article ) {
        Document doc = null;
        TransformerFactory tFactory = TransformerFactory.newInstance();
        try {
            Transformer transformer = tFactory.newTransformer(new StreamSource(getXmlPath() + "/" + getStylesheet(article, PublishingMediaEnum.PDF).getStylesheetURL()));
            setParameters(transformer,article);
            if (transformerProperties != null) {
                for(Map.Entry e : transformerProperties.entrySet()){
                    transformer.setParameter((String) e.getKey(), e.getValue());
                }
            }else {
                transformer.setParameter("printarticle", "true");
            }

            transformer.setOutputProperties(getOutputProperties());

            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
            DocumentBuilder builder = factory.newDocumentBuilder();

            doc = builder.newDocument();

            transformer.transform(new DOMSource(article.getDocument()), new DOMResult(doc));
        } catch (Exception e) {
            log.error("Exception when generating FO document", e);
        }
        return doc;
    }

    @Override
    public boolean doPublish(Article article, Stylesheet stylesheet) throws TransformerException, IOException {
        FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
        doFOPPublish(foUserAgent);
        Document doc = generateFO(article);
        FileOutputStream stream = null;
        Source src = null;
        Result res = null;
        try {
            Fop fop;
            stream = null;
            if(getFile() != null){
                stream = new FileOutputStream(getFile());
                fop = fopFactory.newFop(MimeConstants.MIME_PDF, foUserAgent, stream);
            }else{
                fop = fopFactory.newFop(MimeConstants.MIME_PDF, foUserAgent);
            }
            src = new DOMSource(doc);
            res = new SAXResult(fop.getDefaultHandler());
        } catch (FOPException e) {
            log.error("FOP error", e);
        }

        TransformerFactory factory = TransformerFactory.newInstance();
        Transformer transformer = factory.newTransformer();
        transformer.transform(src, res);
        if(stream != null){
            stream.close();
        }


        afterTransformComplete();
        return true;
    }

    public abstract void doFOPPublish(FOUserAgent foUserAgent);

    public abstract void afterTransformComplete();

    public void setParameters(Transformer transformer, Article article) {
        transformer.setParameter("articlename",article.getName());

        DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.SHORT,DateFormat.SHORT);
        String lastSaved = dateFormat.format(article.getLastSaved());
        transformer.setParameter("lastsaved",lastSaved);

        transformer.setParameter("charcount",(article.getCurrentNumberOfCharacters()));

        transformer.setParameter("articlestatus",(article.getArticleStatus().getId()));

        transformer.setParameter("articlestatustext",article.getArticleStatus().getName());

    }

    public void setTransformerProperties(Properties transformerProperties) {
        this.transformerProperties = transformerProperties;
    }
}